org.eclipse.vtp.framework.common.commands
Class ExitCommand

java.lang.Object
  extended by org.eclipse.vtp.framework.common.commands.ControllerCommand
      extended by org.eclipse.vtp.framework.common.commands.ExitCommand
All Implemented Interfaces:
ICommand

public final class ExitCommand
extends ControllerCommand

A command that terminates an included process and returns control to the originating process.

Author:
Lonnie Pryor

Constructor Summary
ExitCommand()
          Creates a new ExitCommand.
 
Method Summary
 java.lang.Object exportContents()
          Exports the contents of this command to a simple structure of arrays and serializable values from java.lang.
 java.lang.String getExitValue()
          Returns the value of this exit command.
 java.lang.String[] getVariableNames()
           
 java.lang.Object getVariableValue(java.lang.String name)
           
 void importContents(java.lang.Object contents)
          Configures the contents of this command with a structure previously returned from ICommand.exportContents().
 void setExitValue(java.lang.String exitValue)
          Sets the value of this exit command.
 void setVariableValues(java.lang.String name, java.lang.Object value)
           
 
Methods inherited from class org.eclipse.vtp.framework.common.commands.ControllerCommand
accept
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ExitCommand

public ExitCommand()
Creates a new ExitCommand.

Method Detail

getExitValue

public java.lang.String getExitValue()
Returns the value of this exit command.

Returns:
The value of this exit command.

setExitValue

public void setExitValue(java.lang.String exitValue)
Sets the value of this exit command.

Parameters:
exitValue - The value of this exit command.

getVariableNames

public java.lang.String[] getVariableNames()

getVariableValue

public java.lang.Object getVariableValue(java.lang.String name)

setVariableValues

public void setVariableValues(java.lang.String name,
                              java.lang.Object value)

exportContents

public java.lang.Object exportContents()
Description copied from interface: ICommand
Exports the contents of this command to a simple structure of arrays and serializable values from java.lang.

Returns:
A serializable structure this command can be re-constituted from.

importContents

public void importContents(java.lang.Object contents)
Description copied from interface: ICommand
Configures the contents of this command with a structure previously returned from ICommand.exportContents().

Parameters:
contents - The exported contents structure to load from.